<?php
/* 
 * Copyright (c) 2011 Antoine d'Otreppe de Bouvette
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

class ReflectionParameterInfo {
    /**
     * @var string
     */
    private $type;
    
    /**
     * @var string
     */
    private $description;
    
    /**
     * @var string
     */
    private $name;
    
    /**
     * @param ReflectionDocumentedClass $class
     * @param string $name
     * @param string $type
     * @param string $description
     * @param boolean $optional
     * @param mixed $default
     */
    public function __construct($name, $type, $description,
            $optional=false, $default=true) {
        $this->name = $name;
        $this->type = $type;
        $this->description = $description;
        $this->optional = $optional;
        $this->default = $default;
    }
    
    /**
     * @return string
     */
    public function getType() {
        return $this->type;
    }

    /**
     * @return string
     */
    public function getDescription() {
        return $this->description;
    }

    /**
     * @return string
     */
    public function getName() {
        return $this->name;
    }
    
    /**
     * Returns whether this parameter is optional.
     * 
     * @return boolean true if this parameter is optional
     */
    public function isOptional() {
        return $this->optional;
    }
    
    /**
     * Returns the default value. Meaningless if this parameter is not optional
     * @return string
     */
    public function getDefaultValue() {
        return $this->default;
    }
}
